home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / usr / lib / python2.4 / email / Charset.pyo (.txt) < prev    next >
Python Compiled Bytecode  |  2005-10-18  |  13KB  |  342 lines
  1. # Source Generated with Decompyle++
  2. # File: in.pyo (Python 2.4)
  3.  
  4. import email.base64MIME as email
  5. import email.quopriMIME as email
  6. from email.Encoders import encode_7or8bit
  7. QP = 1
  8. BASE64 = 2
  9. SHORTEST = 3
  10. MISC_LEN = 7
  11. DEFAULT_CHARSET = 'us-ascii'
  12. CHARSETS = {
  13.     'iso-8859-1': (QP, QP, None),
  14.     'iso-8859-2': (QP, QP, None),
  15.     'iso-8859-3': (QP, QP, None),
  16.     'iso-8859-4': (QP, QP, None),
  17.     'iso-8859-9': (QP, QP, None),
  18.     'iso-8859-10': (QP, QP, None),
  19.     'iso-8859-13': (QP, QP, None),
  20.     'iso-8859-14': (QP, QP, None),
  21.     'iso-8859-15': (QP, QP, None),
  22.     'windows-1252': (QP, QP, None),
  23.     'viscii': (QP, QP, None),
  24.     'us-ascii': (None, None, None),
  25.     'big5': (BASE64, BASE64, None),
  26.     'gb2312': (BASE64, BASE64, None),
  27.     'euc-jp': (BASE64, None, 'iso-2022-jp'),
  28.     'shift_jis': (BASE64, None, 'iso-2022-jp'),
  29.     'iso-2022-jp': (BASE64, None, None),
  30.     'koi8-r': (BASE64, BASE64, None),
  31.     'utf-8': (SHORTEST, BASE64, 'utf-8'),
  32.     '8bit': (None, BASE64, 'utf-8') }
  33. ALIASES = {
  34.     'latin_1': 'iso-8859-1',
  35.     'latin-1': 'iso-8859-1',
  36.     'latin_2': 'iso-8859-2',
  37.     'latin-2': 'iso-8859-2',
  38.     'latin_3': 'iso-8859-3',
  39.     'latin-3': 'iso-8859-3',
  40.     'latin_4': 'iso-8859-4',
  41.     'latin-4': 'iso-8859-4',
  42.     'latin_5': 'iso-8859-9',
  43.     'latin-5': 'iso-8859-9',
  44.     'latin_6': 'iso-8859-10',
  45.     'latin-6': 'iso-8859-10',
  46.     'latin_7': 'iso-8859-13',
  47.     'latin-7': 'iso-8859-13',
  48.     'latin_8': 'iso-8859-14',
  49.     'latin-8': 'iso-8859-14',
  50.     'latin_9': 'iso-8859-15',
  51.     'latin-9': 'iso-8859-15',
  52.     'cp949': 'ks_c_5601-1987',
  53.     'euc_jp': 'euc-jp',
  54.     'euc_kr': 'euc-kr',
  55.     'ascii': 'us-ascii' }
  56. CODEC_MAP = {
  57.     'gb2312': 'eucgb2312_cn',
  58.     'big5': 'big5_tw',
  59.     'us-ascii': None }
  60.  
  61. def add_charset(charset, header_enc = None, body_enc = None, output_charset = None):
  62.     """Add character set properties to the global registry.
  63.  
  64.     charset is the input character set, and must be the canonical name of a
  65.     character set.
  66.  
  67.     Optional header_enc and body_enc is either Charset.QP for
  68.     quoted-printable, Charset.BASE64 for base64 encoding, Charset.SHORTEST for
  69.     the shortest of qp or base64 encoding, or None for no encoding.  SHORTEST
  70.     is only valid for header_enc.  It describes how message headers and
  71.     message bodies in the input charset are to be encoded.  Default is no
  72.     encoding.
  73.  
  74.     Optional output_charset is the character set that the output should be
  75.     in.  Conversions will proceed from input charset, to Unicode, to the
  76.     output charset when the method Charset.convert() is called.  The default
  77.     is to output in the same character set as the input.
  78.  
  79.     Both input_charset and output_charset must have Unicode codec entries in
  80.     the module's charset-to-codec mapping; use add_codec(charset, codecname)
  81.     to add codecs the module does not know about.  See the codecs module's
  82.     documentation for more information.
  83.     """
  84.     if body_enc == SHORTEST:
  85.         raise ValueError('SHORTEST not allowed for body_enc')
  86.     
  87.     CHARSETS[charset] = (header_enc, body_enc, output_charset)
  88.  
  89.  
  90. def add_alias(alias, canonical):
  91.     """Add a character set alias.
  92.  
  93.     alias is the alias name, e.g. latin-1
  94.     canonical is the character set's canonical name, e.g. iso-8859-1
  95.     """
  96.     ALIASES[alias] = canonical
  97.  
  98.  
  99. def add_codec(charset, codecname):
  100.     '''Add a codec that map characters in the given charset to/from Unicode.
  101.  
  102.     charset is the canonical name of a character set.  codecname is the name
  103.     of a Python codec, as appropriate for the second argument to the unicode()
  104.     built-in, or to the encode() method of a Unicode string.
  105.     '''
  106.     CODEC_MAP[charset] = codecname
  107.  
  108.  
  109. class Charset:
  110.     """Map character sets to their email properties.
  111.  
  112.     This class provides information about the requirements imposed on email
  113.     for a specific character set.  It also provides convenience routines for
  114.     converting between character sets, given the availability of the
  115.     applicable codecs.  Given a character set, it will do its best to provide
  116.     information on how to use that character set in an email in an
  117.     RFC-compliant way.
  118.  
  119.     Certain character sets must be encoded with quoted-printable or base64
  120.     when used in email headers or bodies.  Certain character sets must be
  121.     converted outright, and are not allowed in email.  Instances of this
  122.     module expose the following information about a character set:
  123.  
  124.     input_charset: The initial character set specified.  Common aliases
  125.                    are converted to their `official' email names (e.g. latin_1
  126.                    is converted to iso-8859-1).  Defaults to 7-bit us-ascii.
  127.  
  128.     header_encoding: If the character set must be encoded before it can be
  129.                      used in an email header, this attribute will be set to
  130.                      Charset.QP (for quoted-printable), Charset.BASE64 (for
  131.                      base64 encoding), or Charset.SHORTEST for the shortest of
  132.                      QP or BASE64 encoding.  Otherwise, it will be None.
  133.  
  134.     body_encoding: Same as header_encoding, but describes the encoding for the
  135.                    mail message's body, which indeed may be different than the
  136.                    header encoding.  Charset.SHORTEST is not allowed for
  137.                    body_encoding.
  138.  
  139.     output_charset: Some character sets must be converted before the can be
  140.                     used in email headers or bodies.  If the input_charset is
  141.                     one of them, this attribute will contain the name of the
  142.                     charset output will be converted to.  Otherwise, it will
  143.                     be None.
  144.  
  145.     input_codec: The name of the Python codec used to convert the
  146.                  input_charset to Unicode.  If no conversion codec is
  147.                  necessary, this attribute will be None.
  148.  
  149.     output_codec: The name of the Python codec used to convert Unicode
  150.                   to the output_charset.  If no conversion codec is necessary,
  151.                   this attribute will have the same value as the input_codec.
  152.     """
  153.     
  154.     def __init__(self, input_charset = DEFAULT_CHARSET):
  155.         input_charset = unicode(input_charset, 'ascii').lower()
  156.         self.input_charset = ALIASES.get(input_charset, input_charset)
  157.         (henc, benc, conv) = CHARSETS.get(self.input_charset, (SHORTEST, BASE64, None))
  158.         if not conv:
  159.             conv = self.input_charset
  160.         
  161.         self.header_encoding = henc
  162.         self.body_encoding = benc
  163.         self.output_charset = ALIASES.get(conv, conv)
  164.         self.input_codec = CODEC_MAP.get(self.input_charset, self.input_charset)
  165.         self.output_codec = CODEC_MAP.get(self.output_charset, self.output_charset)
  166.  
  167.     
  168.     def __str__(self):
  169.         return self.input_charset.lower()
  170.  
  171.     __repr__ = __str__
  172.     
  173.     def __eq__(self, other):
  174.         return str(self) == str(other).lower()
  175.  
  176.     
  177.     def __ne__(self, other):
  178.         return not self.__eq__(other)
  179.  
  180.     
  181.     def get_body_encoding(self):
  182.         '''Return the content-transfer-encoding used for body encoding.
  183.  
  184.         This is either the string `quoted-printable\' or `base64\' depending on
  185.         the encoding used, or it is a function in which case you should call
  186.         the function with a single argument, the Message object being
  187.         encoded.  The function should then set the Content-Transfer-Encoding
  188.         header itself to whatever is appropriate.
  189.  
  190.         Returns "quoted-printable" if self.body_encoding is QP.
  191.         Returns "base64" if self.body_encoding is BASE64.
  192.         Returns "7bit" otherwise.
  193.         '''
  194.         if self.body_encoding == QP:
  195.             return 'quoted-printable'
  196.         elif self.body_encoding == BASE64:
  197.             return 'base64'
  198.         else:
  199.             return encode_7or8bit
  200.  
  201.     
  202.     def convert(self, s):
  203.         '''Convert a string from the input_codec to the output_codec.'''
  204.         if self.input_codec != self.output_codec:
  205.             return unicode(s, self.input_codec).encode(self.output_codec)
  206.         else:
  207.             return s
  208.  
  209.     
  210.     def to_splittable(self, s):
  211.         """Convert a possibly multibyte string to a safely splittable format.
  212.  
  213.         Uses the input_codec to try and convert the string to Unicode, so it
  214.         can be safely split on character boundaries (even for multibyte
  215.         characters).
  216.  
  217.         Returns the string as-is if it isn't known how to convert it to
  218.         Unicode with the input_charset.
  219.  
  220.         Characters that could not be converted to Unicode will be replaced
  221.         with the Unicode replacement character U+FFFD.
  222.         """
  223.         if isinstance(s, unicode) or self.input_codec is None:
  224.             return s
  225.         
  226.         
  227.         try:
  228.             return unicode(s, self.input_codec, 'replace')
  229.         except LookupError:
  230.             return s
  231.  
  232.  
  233.     
  234.     def from_splittable(self, ustr, to_output = True):
  235.         """Convert a splittable string back into an encoded string.
  236.  
  237.         Uses the proper codec to try and convert the string from Unicode back
  238.         into an encoded format.  Return the string as-is if it is not Unicode,
  239.         or if it could not be converted from Unicode.
  240.  
  241.         Characters that could not be converted from Unicode will be replaced
  242.         with an appropriate character (usually '?').
  243.  
  244.         If to_output is True (the default), uses output_codec to convert to an
  245.         encoded format.  If to_output is False, uses input_codec.
  246.         """
  247.         if to_output:
  248.             codec = self.output_codec
  249.         else:
  250.             codec = self.input_codec
  251.         if not isinstance(ustr, unicode) or codec is None:
  252.             return ustr
  253.         
  254.         
  255.         try:
  256.             return ustr.encode(codec, 'replace')
  257.         except LookupError:
  258.             return ustr
  259.  
  260.  
  261.     
  262.     def get_output_charset(self):
  263.         '''Return the output character set.
  264.  
  265.         This is self.output_charset if that is not None, otherwise it is
  266.         self.input_charset.
  267.         '''
  268.         if not self.output_charset:
  269.             pass
  270.         return self.input_charset
  271.  
  272.     
  273.     def encoded_header_len(self, s):
  274.         '''Return the length of the encoded header string.'''
  275.         cset = self.get_output_charset()
  276.         if self.header_encoding == BASE64:
  277.             return email.base64MIME.base64_len(s) + len(cset) + MISC_LEN
  278.         elif self.header_encoding == QP:
  279.             return email.quopriMIME.header_quopri_len(s) + len(cset) + MISC_LEN
  280.         elif self.header_encoding == SHORTEST:
  281.             lenb64 = email.base64MIME.base64_len(s)
  282.             lenqp = email.quopriMIME.header_quopri_len(s)
  283.             return min(lenb64, lenqp) + len(cset) + MISC_LEN
  284.         else:
  285.             return len(s)
  286.  
  287.     
  288.     def header_encode(self, s, convert = False):
  289.         '''Header-encode a string, optionally converting it to output_charset.
  290.  
  291.         If convert is True, the string will be converted from the input
  292.         charset to the output charset automatically.  This is not useful for
  293.         multibyte character sets, which have line length issues (multibyte
  294.         characters must be split on a character, not a byte boundary); use the
  295.         high-level Header class to deal with these issues.  convert defaults
  296.         to False.
  297.  
  298.         The type of encoding (base64 or quoted-printable) will be based on
  299.         self.header_encoding.
  300.         '''
  301.         cset = self.get_output_charset()
  302.         if convert:
  303.             s = self.convert(s)
  304.         
  305.         if self.header_encoding == BASE64:
  306.             return email.base64MIME.header_encode(s, cset)
  307.         elif self.header_encoding == QP:
  308.             return email.quopriMIME.header_encode(s, cset, maxlinelen = None)
  309.         elif self.header_encoding == SHORTEST:
  310.             lenb64 = email.base64MIME.base64_len(s)
  311.             lenqp = email.quopriMIME.header_quopri_len(s)
  312.             if lenb64 < lenqp:
  313.                 return email.base64MIME.header_encode(s, cset)
  314.             else:
  315.                 return email.quopriMIME.header_encode(s, cset, maxlinelen = None)
  316.         else:
  317.             return s
  318.  
  319.     
  320.     def body_encode(self, s, convert = True):
  321.         '''Body-encode a string and convert it to output_charset.
  322.  
  323.         If convert is True (the default), the string will be converted from
  324.         the input charset to output charset automatically.  Unlike
  325.         header_encode(), there are no issues with byte boundaries and
  326.         multibyte charsets in email bodies, so this is usually pretty safe.
  327.  
  328.         The type of encoding (base64 or quoted-printable) will be based on
  329.         self.body_encoding.
  330.         '''
  331.         if convert:
  332.             s = self.convert(s)
  333.         
  334.         if self.body_encoding is BASE64:
  335.             return email.base64MIME.body_encode(s)
  336.         elif self.body_encoding is QP:
  337.             return email.quopriMIME.body_encode(s)
  338.         else:
  339.             return s
  340.  
  341.  
  342.